vcAuthorContext

vcAuthorContext is the context of the application for component modeling.

See in: Overview

Module: vcCore

Parent: vcContext

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
ActiveComponentvcComponentRWGets or sets the active component in context, thereby clearing ActiveNode and ActiveFeatures properties.
ActiveFeatureslistRGets a list of active features in context and pairs them with containing node. Format List[Tuple[vcNode, List[vcFeature]]].
See more
Note: only selecting the features using vcSelectionManager doesn't update this list, use setActiveFeatures method instead.
ActiveNodevcNodeRWGets or sets the active node in context, thereby clearing the ActiveFeatures properties.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
setActiveFeatureNonevcFeature activeFeature,
vcNode activeNode
Sets a given feature in a given node as the active feature in context.
See more
Parameters:
activeFeature (vcFeature): New active feature.
activeNode (vcNode): New active node.

Returns:
None
setActiveFeaturesNonelist nodeFeatureListSets a given list of features in nodes as the active features in context.
See more
Parameters:
nodeFeatureList (List[Tuple[vcNode, List[vcFeature]]]): The list of nodes and features to set active.

Returns:
None

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnActiveComponentChangedNoneEvent triggered when a different component becomes the active component in context.

Parameters:
None
OnActiveFeaturesChangedNoneEvent triggered when a different feature or set of features become the active feature(s) in context.

Parameters:
None